home *** CD-ROM | disk | FTP | other *** search
/ IRIX 6.2 Development Libraries / SGI IRIX 6.2 Development Libraries.iso / dist / complib.idb / usr / share / catman / p_man / cat3 / complib / sgees.z / sgees
Text File  |  1996-03-14  |  6KB  |  199 lines
  1.  
  2.  
  3.  
  4. SSSSGGGGEEEEEEEESSSS((((3333FFFF))))                                                            SSSSGGGGEEEEEEEESSSS((((3333FFFF))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      SGEES - compute for an N-by-N real nonsymmetric matrix A, the
  10.      eigenvalues, the real Schur form T, and, optionally, the matrix of Schur
  11.      vectors Z
  12.  
  13. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  14.      SUBROUTINE SGEES( JOBVS, SORT, SELECT, N, A, LDA, SDIM, WR, WI, VS, LDVS,
  15.                        WORK, LWORK, BWORK, INFO )
  16.  
  17.          CHARACTER     JOBVS, SORT
  18.  
  19.          INTEGER       INFO, LDA, LDVS, LWORK, N, SDIM
  20.  
  21.          LOGICAL       BWORK( * )
  22.  
  23.          REAL          A( LDA, * ), VS( LDVS, * ), WI( * ), WORK( * ), WR( * )
  24.  
  25.          LOGICAL       SELECT
  26.  
  27.          EXTERNAL      SELECT
  28.  
  29. PPPPUUUURRRRPPPPOOOOSSSSEEEE
  30.      SGEES computes for an N-by-N real nonsymmetric matrix A, the eigenvalues,
  31.      the real Schur form T, and, optionally, the matrix of Schur vectors Z.
  32.      This gives the Schur factorization A = Z*T*(Z**T).
  33.  
  34.      Optionally, it also orders the eigenvalues on the diagonal of the real
  35.      Schur form so that selected eigenvalues are at the top left.  The leading
  36.      columns of Z then form an orthonormal basis for the invariant subspace
  37.      corresponding to the selected eigenvalues.
  38.  
  39.      A matrix is in real Schur form if it is upper quasi-triangular with 1-
  40.      by-1 and 2-by-2 blocks. 2-by-2 blocks will be standardized in the form
  41.              [  a  b  ]
  42.              [  c  a  ]
  43.  
  44.      where b*c < 0. The eigenvalues of such a block are a +- sqrt(bc).
  45.  
  46.  
  47. AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  48.      JOBVS   (input) CHARACTER*1
  49.              = 'N': Schur vectors are not computed;
  50.              = 'V': Schur vectors are computed.
  51.  
  52.      SORT    (input) CHARACTER*1
  53.              Specifies whether or not to order the eigenvalues on the diagonal
  54.              of the Schur form.  = 'N': Eigenvalues are not ordered;
  55.              = 'S': Eigenvalues are ordered (see SELECT).
  56.  
  57.      SELECT  (input) LOGICAL FUNCTION of two REAL arguments
  58.              SELECT must be declared EXTERNAL in the calling subroutine.  If
  59.              SORT = 'S', SELECT is used to select eigenvalues to sort to the
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. SSSSGGGGEEEEEEEESSSS((((3333FFFF))))                                                            SSSSGGGGEEEEEEEESSSS((((3333FFFF))))
  71.  
  72.  
  73.  
  74.              top left of the Schur form.  If SORT = 'N', SELECT is not
  75.              referenced.  An eigenvalue WR(j)+sqrt(-1)*WI(j) is selected if
  76.              SELECT(WR(j),WI(j)) is true; i.e., if either one of a complex
  77.              conjugate pair of eigenvalues is selected, then both complex
  78.              eigenvalues are selected.  Note that a selected complex
  79.              eigenvalue may no longer satisfy SELECT(WR(j),WI(j)) = .TRUE.
  80.              after ordering, since ordering may change the value of complex
  81.              eigenvalues (especially if the eigenvalue is ill-conditioned); in
  82.              this case INFO is set to N+2 (see INFO below).
  83.  
  84.      N       (input) INTEGER
  85.              The order of the matrix A. N >= 0.
  86.  
  87.      A       (input/output) REAL array, dimension (LDA,N)
  88.              On entry, the N-by-N matrix A.  On exit, A has been overwritten
  89.              by its real Schur form T.
  90.  
  91.      LDA     (input) INTEGER
  92.              The leading dimension of the array A.  LDA >= max(1,N).
  93.  
  94.      SDIM    (output) INTEGER
  95.              If SORT = 'N', SDIM = 0.  If SORT = 'S', SDIM = number of
  96.              eigenvalues (after sorting) for which SELECT is true. (Complex
  97.              conjugate pairs for which SELECT is true for either eigenvalue
  98.              count as 2.)
  99.  
  100.      WR      (output) REAL array, dimension (N)
  101.              WI      (output) REAL array, dimension (N) WR and WI contain the
  102.              real and imaginary parts, respectively, of the computed
  103.              eigenvalues in the same order that they appear on the diagonal of
  104.              the output Schur form T.  Complex conjugate pairs of eigenvalues
  105.              will appear consecutively with the eigenvalue having the positive
  106.              imaginary part first.
  107.  
  108.      VS      (output) REAL array, dimension (LDVS,N)
  109.              If JOBVS = 'V', VS contains the orthogonal matrix Z of Schur
  110.              vectors.  If JOBVS = 'N', VS is not referenced.
  111.  
  112.      LDVS    (input) INTEGER
  113.              The leading dimension of the array VS.  LDVS >= 1; if JOBVS =
  114.              'V', LDVS >= N.
  115.  
  116.      WORK    (workspace/output) REAL array, dimension (LWORK)
  117.              On exit, if INFO = 0, WORK(1) contains the optimal LWORK.
  118.  
  119.      LWORK   (input) INTEGER
  120.              The dimension of the array WORK.  LWORK >= max(1,3*N).  For good
  121.              performance, LWORK must generally be larger.
  122.  
  123.      BWORK   (workspace) LOGICAL array, dimension (N)
  124.              Not referenced if SORT = 'N'.
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. SSSSGGGGEEEEEEEESSSS((((3333FFFF))))                                                            SSSSGGGGEEEEEEEESSSS((((3333FFFF))))
  137.  
  138.  
  139.  
  140.      INFO    (output) INTEGER
  141.              = 0: successful exit
  142.              < 0: if INFO = -i, the i-th argument had an illegal value.
  143.              > 0: if INFO = i, and i is
  144.              <= N: the QR algorithm failed to compute all the
  145.              eigenvalues; elements 1:ILO-1 and i+1:N of WR and WI contain
  146.              those eigenvalues which have converged; if JOBVS = 'V', VS
  147.              contains the matrix which reduces A to its partially converged
  148.              Schur form.  = N+1: the eigenvalues could not be reordered
  149.              because some eigenvalues were too close to separate (the problem
  150.              is very ill-conditioned); = N+2: after reordering, roundoff
  151.              changed values of some complex eigenvalues so that leading
  152.              eigenvalues in the Schur form no longer satisfy SELECT=.TRUE.
  153.              This could also be caused by underflow due to scaling.
  154.  
  155.  
  156.  
  157.  
  158.  
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.